package com.gzy.rpsm_admin.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @Configuration 告诉Spring，这个类包含了Spring容器管理的Bean(Java对象)的声明。
 * Spring容器会在启动时扫描这个类，并读取其中通过@Bean注解定义的方法，
 * 然后基于这些方法中的逻辑来创建相关对象和注册到Spring容器中。
 */
@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean// 告诉Spring，使用createRestApi()方法创建Docket的实例对象并帮助管理
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)  // 代表swagger3
                .apiInfo(apiInfo()) // 用于生成API信息
                .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
                .apis(RequestHandlerSelectors.basePackage("com.gzy.rpsm_admin.controller")) //指定扫描哪个包下的接口
                .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里
                .build();
    }
    /**
     * 用于定义API主界面的信息，比如可以声明所有的API的总标题、描述、版本
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("物业管理项目管理员系统") //  可以用来自定义API的主标题
                .contact(new Contact("gzy", "https://xxx.com", "kaokao_li@163.com")) // 联系人信息
                .description("进行基础资料的管理") // 可以用来描述整体的API
                .termsOfServiceUrl("") // 用于定义服务的域名
                .version("1.0") // 可以用来定义版本。
                .build(); //
    }
}
